Skip to content

Conversation

@nenharper
Copy link
Contributor

This PR makes the app roles page more narrative and adds a corresponding reference page for app roles

Copy link
Member

@Ethan-Arrowood Ethan-Arrowood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking good. I think the example could also be a little longer to demonstrate multi-roles too by including the other tables/resources the guide has introduced thus far.

Comment on lines 33 to 37
## Step 2: Assign the Role

Now that the role exists, assign it to a user. You can do this through the [Users and Roles API](../security/users-and-roles) or via the CLI. Once assigned, the user’s permissions will reflect exactly what you declared in `roles.yaml`.

For example, a user with the `dog_reader` role can insert new dog records, but not delete or update them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to walk the user through these steps now. Help them create a non-super-user user and assign that user this role. Then demonstrate some requests. Show how given one role or the other (in the authentication header of the request) results in different responses (likely 200 vs 4xx)

The structure of the roles.yaml file is:
## Step 3: See It in Action

Try it out. Sign in as the user with the `dog_reader` role and attempt the following:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign in? Where? The following examples use CURL requests without actually providing any authentication headers.

Copy link
Member

@Ethan-Arrowood Ethan-Arrowood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Please make the change to the role name as Kris' comment mentions and then copy this to the docs/ folder as well as 4.5 and 4.4 versions.

Copy link
Member

@Ethan-Arrowood Ethan-Arrowood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@Ethan-Arrowood Ethan-Arrowood merged commit cfb1051 into main Sep 30, 2025
5 checks passed
@Ethan-Arrowood Ethan-Arrowood deleted the nenne/define-roles branch September 30, 2025 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants